vcStatisticsDashboard

vcStatisticsDashboard is an object type used for visualizing and reporting statistics collected during a simulation. The Statistics dashboard consists of tabs, which are of type vcStatisticsTab. Each tab contains a layout of one or more charts, which are of type vcStatisticsChart. Each chart uses a sampling interval to report one or more data series, which are of type vcStatisticsSeries. Tips: Use vcStatisticsDashboard to create, select or delete tabs. Use vcStatisticsTab to create, select or delete charts and define how charts are organized in a tab. Use vcStatisticsChart to add, select, delete, clear or update data series as well as edit the position and attributes of a chart. Use vcStatisticsSeries to define which property and from what components is reported in a chart.

See in: Overview

Module: vcCore

Parent: -

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Dashboards	list	R	Gets all dashboards in the application.
SelectedTab	vcStatisticsTab	RW	Gets or sets the active tab in the dashboard.
StatisticsInterval	Real	RW	Gets or sets the global sampling interval for reporting data. See more This will affect data series referencing vcStatistics properties as well as any chart with a sampling interval of -1.
Tabs	list	R	Gets all the tabs in dashboard.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
createTab	vcStatisticsTab	String name, Optional Keyword[activate = Boolean]	Creates and adds a new tab of a given name to the dashboard. See more Parameters: name (String): Name for the new tab. Optional: activate (Boolean): Defines if the new tab is made as a selected tab. Returns: vcStatisticsTab: The newly created tab.